Get Code Value by Entity Code

Path

http://{supOS ip:port}/open-api/systemcode/v2/entities/{entityCode}/values

Query parameter

• keyword: Keyword for fuzzy matching.
• includeDeleted: Whether to contain deleted code values. The default is false.
• current: Required integer. Current page number, starting from 1.
• pageSize: Required integer. Items on the page, default is 20 and the maximum is 100.

Header parameter

Accept-Language: Default is the server language. Options are en-us and zh-cn.

Response

• 200: Successful.

{
  "list": [
    {
      "code": "hangzhou",
      "name": "sys.hangzhou",
      "displayName": "Hangzhou"
    },
    {
      "code": "zhengzhou",
      "name": "sys.zhengzhou",
      "displayName": "Zhengzhou"
    }
  ],
  "pagination": {
    "total": 2,
    "pageSize": 20,
    "current": 1
  }
}

• 400

{
  "code": 100111010,
  "message": "entityCode cannot be empty"
}

• 100111011: Current page number cannot be empty.
• 100111012: Number of items per page cannot be empty.
• 100111013: Current page number cannot be less than 1.
• 100111014: Number of items per page cannot be less than 1.
• 100111015: Number of items per page cannot be greater than 100.
• 100111016: Entity corresponding to the system code does not exist.

Get Code Details by Entity Code and Value Code

Path

http://{supOS ip:port}/open-api/systemcode/v2/entities/{entityCode}/values/{valueCodes}

Query parameter

includeDeleted: Whether to contain deleted code values. The default is false.

Header parameter

Accept-Language: Default is the server language. Options are en-us and zh-cn.

Response

• 200: Successful.

{
  "list": [
    {
      "code": "hangzhou",
      "name": "sys.hangzhou",
      "displayName": "Hangzhou"
    },
    {
      "code": "zhengzhou",
      "name": "sys.zhengzhou",
      "displayName": "Zhengzhou"
    }
  ]
}

• 400

{
  "code": 100111010,
  "message": "entityCode cannot be empty"
}

• 100111016: Entity corresponding to the system code does not exist.
• 100111018: Value code array cannot be longer than 20.